Enterprise Objects > Enterprise Operations > CygNet Native Operations > Point

Point Operations

Read Operations Description

GetPointAttrList

Returns point information from a PNT.

GetFacilityPointList

Given a service name (UIS or CVS), a facility attribute search filter, a point attribute search filter, a list of facility attributes to return, and a list of point attributes to return, this operation returns a list of points matched by the combined filter, each including the requested facility and point attributes.

GetUdcListForFacilities

Returns the list of UDCs that are included in points for each of the facility IDs provided.
Write Operations Description

AddPoint

Adds a new point record, given a service name (PNT, UIS or CVS) and a list of point attributes/value pairs.

AddPoints

Adds new point records, given a service name (PNT, UIS or CVS) and a list of point attributes/value pairs.

UpdatePoint

Updates the attributes of an existing point record, given a service name (PNT, UIS or CVS), a point tag and a list of point attributes/value pairs.

UpdatePoints

Updates the attributes of multiple existing point records, given a service name (PNT, UIS or CVS), a point tag, and a list of point attributes/value pairs.

DeletePoint

Deletes the specified point record, given a service name (PNT, UIS or CVS) and a point tag.

DeletePoints

Deletes multiple specified point records, given a service name (PNT, UIS or CVS) and a list of point tags.

GetPointAttrList

Given a service name (PNT, UIS or CVS), a point attribute search filter and a list of point attributes to return, this operation will return an XML response containing the list of points matched by the filter, each including the point attributes requested.  Point attributes available include all real-time and configuration attributes. 

In addition to the other attribute categories to return, the request may contain an unbounded list of history attributes, each of which contains point-in-time/rollup information, along with a set of standard real-time attributes to retrieve from that point-in-time.  If history values do not exist for the point requested, and the optional attribute is set to "true" as in the following example, the response will not include an error for the missing point history data.

<PointInTime optional="true">[…]</PointInTime>

If set to "false" or not included in the request, the response will include an error.

The return XML will also indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetPointAttrListReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a PNT, UIS, or CVS Site.Service.  If a UIS or CVS is specified, the service will resolve to its associated PNT.

PointFilter

No

A set of rules to filter the returned points by point configuration attributes (using the child element <PointConfigFilter>) and point real-time attributes (using the child element <PointRealtimeFilter>)

AttrsToExport

No

Indicates the set of point attributes to include for each returned point. Attributes include the following:

  • Point attributes (configuration or real-time, <PointAttributes>)
  • Point-in-Time attributes (<PointInTime>)
Filter

The point filter node (<PointFilter>) must contain a set of rules (based on point configuration attributes and/or point real-time attributes) used to filter the points which will be returned by this operation.  Each filter may consist of a hierarchy of expressions using the <MultiExpr> and <SingleExpr> tags.  The following example will filter all points for which PointUDC equals “SVMSTST” OR “SVMCTIMEL”, and PointTimestamp equals “2011-10-02-T00:07:00.834”.

<PointFilter>

<PointConfigFilter>

<MultiExpr operator="OR" inverse="false">

<SingleExpr compare="EQ">

<PointUniformDataCode>SVMSTST</PointUniformDataCode>

</SingleExpr>

<SingleExpr compare="EQ">

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

</SingleExpr>

</MultiExpr>

</PointConfigFilter>

<PointRealtimeFilter>

<SingleExpr compare="GT" qualify="Timestamp">

<PointTimestamp>2011-10-02T00:07:00.834</PointTimestamp>

</SingleExpr>

</PointRealtimeFilter>

</PointFilter>
Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service.  If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721" >

<GetPointAttrListReq>

<SvcName>CYGDEMO.SVCMON</SvcName>

<PointFilter>

<PointConfigFilter>

<MultiExpr operator="OR" inverse="false">

<SingleExpr compare="EQ">

<PointUniformDataCode>SVMSTST</PointUniformDataCode>

</SingleExpr>

<SingleExpr compare="EQ">

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

</SingleExpr>

</MultiExpr>

</PointConfigFilter>

<PointRealtimeFilter>

<SingleExpr compare="GT" qualify="Timestamp">

<PointTimestamp>2011-10-02T00:07:00.834</PointTimestamp>

</SingleExpr>

</PointRealtimeFilter>

</PointFilter>

<AttrsToExport>

<PointAttributes>

<PointValue/>

<PointTimestamp/>

<PointSiteService/>

<PointDescription/>

<PointFacilityId/>

<PointUniformDataCode/>

<PointHistoryOnlineDays/>

</PointAttributes>

</AttrsToExport>

</GetPointAttrListReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<GetPointAttrListResp>

<PointList>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_ACS_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA_ACS</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011071318250185</PointValue>

<PointTimestamp>2011-11-07T05:39:31.632Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_FAC_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA_FAC</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011071318250185</PointValue>

<PointTimestamp>2011-11-07T05:39:31.632Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_PNT_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA_PNT</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011071318250186</PointValue>

<PointTimestamp>2011-11-07T05:39:31.632Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_RSM_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA_RSM</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011072709450510</PointValue>

<PointTimestamp>2011-11-07T05:39:31.632Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_TRS_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA_TRS</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011071318250186</PointValue>

<PointTimestamp>2011-11-07T05:39:31.632Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_UIS_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA_UIS</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011071318250188</PointValue>

<PointTimestamp>2011-11-07T05:39:31.632Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_VHS_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA_VHS</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011071318250188</PointValue>

<PointTimestamp>2011-11-07T05:39:31.632Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:WINTRLCY_ACS_SVMCTIMEL">

<PointAttributes>

<PointDescription>Curr Time Local</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>WINTRLCY_ACS</PointFacilityId>

<PointUniformDataCode>SVMCTIMEL</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>2011110622393161</PointValue>

<PointTimestamp>2011-11-07T05:39:31.611Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_CLEBURNE_SVMSTST">

<PointAttributes>

<PointDescription>Site Status</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_CLEBURNE</PointFacilityId>

<PointUniformDataCode>SVMSTST</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>FAILED, 1</PointValue>

<PointTimestamp>2011-11-07T05:39:32.054Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:5999_ZAPATA_SVMSTST">

<PointAttributes>

<PointDescription>Site Status</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>5999_ZAPATA</PointFacilityId>

<PointUniformDataCode>SVMSTST</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>OOS, 13</PointValue>

<PointTimestamp>2011-11-07T05:39:32.054Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:WINTRLCY_SVMSTST">

<PointAttributes>

<PointDescription>Site Status</PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>WINTRLCY</PointFacilityId>

<PointUniformDataCode>SVMSTST</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>OK, 21</PointValue>

<PointTimestamp>2011-11-07T05:39:32.054Z</PointTimestamp>

</PointAttributes>

</Point>

<Point PointTag="CYGDEMO.SVCMON:CYGDEMO_SVMSTST">

<PointAttributes>

<PointDescription></PointDescription>

<PointSiteService>CYGDEMO.SVCMON</PointSiteService>

<PointFacilityId>CYGDEMO</PointFacilityId>

<PointUniformDataCode>SVMSTST</PointUniformDataCode>

<PointHistoryOnlineDays>30</PointHistoryOnlineDays>

<PointValue>FAILED, 6</PointValue>

<PointTimestamp>2011-11-07T05:39:32.054Z</PointTimestamp>

</PointAttributes>

</Point>

</PointList>

<OperationResults success="true" resp_timestamp="2011-11-07T05:40:14.961Z" exec_duration="PT0.895S" />

</GetPointAttrListResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<GetPointAttrListResp>

<PointList />

<OperationResults success="false" resp_timestamp="2011-07-30T22:12:45.808Z" exec_duration="PT0.002S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS0</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</GetPointAttrListResp>

</CygNetEnterpriseOperations>
Back to top

GetFacilityPointList

Given a service name (UIS or CVS), a facility attribute search filter, a point attribute search filter, a list of facility attributes to return, and a list of point attributes to return, this operation will return an XML response containing the list of points matched by the combined filter, each including the facility attributes and point attributes requested. Point attributes available include all real-time and configuration attributes.

In addition to the other attribute categories to return, the request may contain an unbounded list of history attributes, each of which contains point-in-time/rollup information along with a set of standard real-time attributes to retrieve from that point-in-time.  If history values do not exist for the point requested, and the optional attribute is set to "true" as in the following example, the response will not include an error for the missing point history data.

<PointInTime optional="true">[…]</PointInTime>

If set to "false" or not included in the request, the response will include an error.

The return XML will also indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetFacilityPointListReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a UIS or CVS Site.Service. 

FacilityPointFilter

No

A set of rules to filter the returned points by facility attributes (<FacilityFilter>) and/or point attributes (<ForEachFacilityPointFilter>).  Point attributes include real-time attributes (<PointRealtimeFilter>) and configuration attributes (<PointConfigFilter>).

AttrsToExport

No

Indicates the set of attributes to include for each returned point. Attributes include the following:

  • Facility attributes (<FacilityAttributes>)
  • Point attributes (configuration or real-time, <PointAttributes>)
  • Point-in-Time attributes (<PointInTime>)
Filter

The facility/point filter node (<FacilityPointFilter>) must contain a set of rules (based on facility attributes, point configuration attributes, and/or point real-time attributes) used to filter the points which will be returned by this operation.  Each filter may consist of a hierarchy of expressions using the <MultiExpr> and <SingleExpr> tags.  The following example will filter all points for which FacilityAttr0 contains the string “test”, and PointTimestamp is greater than “2011-08-03-T00:00:00.000” AND PointTimestamp is less than “2011-08-05T00:00:00.000” AND PointIs_CfgBit01_Set is true.

<FacilityPointFilter>

<FacilityFilter>

<SingleExpr compare="NE">

<FacilityAttr0>*test*</FacilityAttr0>

</SingleExpr>

</FacilityFilter>

<ForEachFacilityPointFilter>

<PointRealtimeFilter>

<MultiExpr operator="AND" inverse="false">

<SingleExpr compare="GT" qualify="Timestamp">

<PointTimestamp>2011-08-03T00:00:00.000Z</PointTimestamp>

</SingleExpr>

<SingleExpr compare="LT" qualify="Timestamp">

<PointTimestamp>2011-08-05T00:00:00.000Z</PointTimestamp>

</SingleExpr>

<SingleExpr compare="EQ">

<PointIs_CfgBit01_Set>Yes</PointIs_CfgBit01_Set>

</SingleExpr>

</MultiExpr>

</PointRealtimeFilter>

</ForEachFacilityPointFilter>

</FacilityPointFilter>
Target Services

The service name node (<SvcName>) must specify the name of a UIS or CVS Site.Service.

Examples

Request

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721" >

<GetFacilityPointListReq>

<SvcName>CYGDEMO.UIS</SvcName>

<FacilityPointFilter>

<FacilityFilter>

<SingleExpr compare="NE">

<FacilityAttr0>*test*</FacilityAttr0>

</SingleExpr>

</FacilityFilter>

<ForEachFacilityPointFilter>

<PointRealtimeFilter>

<MultiExpr operator="AND" inverse="false">

<SingleExpr compare="GT" qualify="Timestamp">

<PointTimestamp>2011-08-03T00:00:00.000Z</PointTimestamp>

</SingleExpr>

<SingleExpr compare="LT" qualify="Timestamp">

<PointTimestamp>2011-08-05T00:00:00.000Z</PointTimestamp>

</SingleExpr>

<SingleExpr compare="EQ">

<PointIs_CfgBit01_Set>Yes</PointIs_CfgBit01_Set>

</SingleExpr>

</MultiExpr>

</PointRealtimeFilter>

</ForEachFacilityPointFilter>

</FacilityPointFilter>

<AttrsToExport>

<FacilityAttributes>

<FacilitySite/>

<FacilityService/>

<FacilityId/>

<FacilityType/>

<FacilityDesc/>

</FacilityAttributes>

<PointAttributes>

<PointValue/>

<PointTimestamp/>

</PointAttributes>

<PointInTime>

<HistoryParameters>

<DateTime>2011-08-01T00:00:00Z</DateTime>

<RollupType>Thin Median</RollupType>

<RollupPeriod>42</RollupPeriod>

<RollupUnits>Days</RollupUnits>

</HistoryParameters>

<HistoryAttributes>

<PointValue/>

<PointTimestamp/>

<PointStateDescription/>

</HistoryAttributes>

</PointInTime>

<PointInTime>

<HistoryParameters>

<DateTime>2011-09-01T00:00:00Z</DateTime>

<RollupType>Calc Weighted Avg</RollupType>

<RollupPeriod>42</RollupPeriod>

<RollupUnits>Days</RollupUnits>

</HistoryParameters>

<HistoryAttributes>

<PointValue/>

<PointTimestamp/>

</HistoryAttributes>

</PointInTime>

</AttrsToExport>

</GetFacilityPointListReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<GetFacilityPointListResp>

<FacilityPointList>

<Point PointTag="CYGDEMO.UIS:TEST_SYCSCRY">

<FacilityAttributes>

<FacilitySite>CYGDEMO</FacilitySite>

<FacilityService>UIS</FacilityService>

<FacilityId>TEST</FacilityId>

<FacilityType></FacilityType>

<FacilityDesc>Temp facility for testing EntOps</FacilityDesc>

</FacilityAttributes>

<PointAttributes>

<PointValue>1764</PointValue>

<PointTimestamp>2011-08-04T00:00:00.000Z</PointTimestamp>

</PointAttributes>

<PointInTime>

<HistoryParameters>

<DateTime>2011-08-01T00:00:00.000Z</DateTime>

<TimeAdj></TimeAdj>

<RollupType>Thin Median</RollupType>

<RollupUnits>Days</RollupUnits>

<RollupPeriod>42</RollupPeriod>

<TopOfSubUnit>0</TopOfSubUnit>

</HistoryParameters>

<HistoryAttributes>

<PointValue>1764</PointValue>

<PointTimestamp>2011-08-04T00:00:00.000Z</PointTimestamp>

<PointStateDescription>Analog High Out of Range</PointStateDescription>

</HistoryAttributes>

</PointInTime>

<PointInTime>

<HistoryParameters>

<DateTime>2011-09-01T00:00:00.000Z</DateTime>

<TimeAdj></TimeAdj>

<RollupType>Calc Weighted Avg</RollupType>

<RollupUnits>Days</RollupUnits>

<RollupPeriod>42</RollupPeriod>

<TopOfSubUnit>0</TopOfSubUnit>

</HistoryParameters>

<HistoryAttributes>

<PointValue>1190</PointValue>

<PointTimestamp>2011-09-01T00:00:00.000Z</PointTimestamp>

</HistoryAttributes>

</PointInTime>

</Point>

</FacilityPointList>

<OperationResults success="true" resp_timestamp="2011-12-02T23:39:39.859Z" exec_duration="PT2.981S" />

</GetFacilityPointListResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<GetFacilityPointListResp>

<FacilityPointList />

<OperationResults success="false" resp_timestamp="2011-07-30T22:13:14.235Z" exec_duration="PT0.002S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS0</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</GetFacilityPointListResp>

</CygNetEnterpriseOperations>
Back to top

GetUdcListForFacilities

Given a list of facility tags, this operation will return an XML response containing the list of UDCs that exist as points for each of the facility tags provided.  The return XML will also indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<GetUdcListForFacilitiesReq>).

Element Name Required Description

FacilityTag

Yes

The facility tag for which to retrieve the UDC list.  More than one <FacilityTag> node may be specified.

Examples

Request

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721" >

<GetUdcListForFacilitiesReq>

<FacilityTag>CYGDEMO.UIS::ENTOPSTEST</FacilityTag>

<FacilityTag>CYGDEMO.SVCMON::TEST1</FacilityTag>

</GetUdcListForFacilitiesReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<GetUdcListForFacilitiesResp>

<UdcList FacilityTag="CYGDEMO.SVCMON::TEST1">

<UDC>SVMACLI</UDC>

<UDC>SVMAMSG</UDC>

<UDC>SVMAUDTXDL</UDC>

<UDC>SVMAUDTXVL</UDC>

<UDC>SVMBGVALID</UDC>

<UDC>SVMCASACK</UDC>

<UDC>SVMCASCURR</UDC>

<UDC>SVMCASELSQ</UDC>

<UDC>SVMCASIGN</UDC>

<UDC>SVMCASPRST</UDC>

<UDC>SVMCASPRTQ</UDC>

<UDC>SVMCASRSET</UDC>

<UDC>SVMCASRULE</UDC>

<UDC>SVMCASSET</UDC>

<UDC>SVMCASTOT</UDC>

<UDC>SVMCASUACK</UDC>

<UDC>SVMCPUT</UDC>

<UDC>SVMCVSCASQ</UDC>

<UDC>SVMCVSCFGQ</UDC>

<UDC>SVMCVSCTLQ</UDC>

<UDC>SVMCVSDALM</UDC>

<UDC>SVMCVSGNSQ</UDC>

<UDC>SVMCVSMP</UDC>

<UDC>SVMCVSRPTD</UDC>

<UDC>SVMCVSSALM</UDC>

<UDC>SVMCVSTP</UDC>

<UDC>SVMVHSRAER</UDC>

<UDC>SVMVHSRMIS</UDC>

<UDC>SVMVHSRNCH</UDC>

<UDC>SVMVHSRRCV</UDC>

<UDC>SVMVHSUNCH</UDC>

<UDC>SVMVHSUVCH</UDC>

<UDC>SVMVHSVFM</UDC>

<UDC>SVMVHSVFS</UDC>

<UDC>SVMVHSVFU</UDC>

<UDC>SVMVIRT</UDC>

<UDC>SVMVIRTPA</UDC>

<UDC>SVMVIRTPT</UDC>

<UDC>SVMWRKSET</UDC>

</UdcList>

<UdcList FacilityTag="CYGDEMO.UIS::ENTOPSTEST">

<UDC>EODFAIL</UDC>

<UDC>EODSUCC</UDC>

<UDC>EOFCC</UDC>

<UDC>EOPENDT</UDC>

<UDC>EOTET</UDC>

<UDC>EOTFP</UDC>

<UDC>EOTST</UDC>

<UDC>EOTSTS</UDC>

<UDC>SYEOCHARCT</UDC>

<UDC>SYEODURATN</UDC>

<UDC>SYEOFAILCT</UDC>

<UDC>SYEOFAILOP</UDC>

<UDC>SYEOLASTOP</UDC>

<UDC>SYEOPENDCT</UDC>

<UDC>SYEOPROCCT</UDC>

<UDC>SYEOSTATUS</UDC>

<UDC>SYEOSUCCCT</UDC>

<UDC>SYEOSUCCOP</UDC>

</UdcList>

<OperationResults success="true" resp_timestamp="2011-10-05T22:33:52.961Z" exec_duration="PT0.662S"></OperationResults>

</GetUdcListForFacilitiesResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<GetUdcListForFacilitiesResp>

<OperationResults success="false" resp_timestamp="2011-07-30T22:12:40.821Z" exec_duration="PT0.002S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS0</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</GetUdcListForFacilitiesResp>

</CygNetEnterpriseOperations>
Back to top

AddPoints

Given a service name (PNT, UIS or CVS) and a list of point attributes/value pairs, this operation will add new point records.  The list of point attributes provided must include the minimum set, as specified in the XML schema, to establish at least one valid point record.  This minimum set is comprised of the site and service, as well as the Long Point ID AND/OR the Facility ID and Uniform Data Code. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<AddPointsReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to add a point.  Otherwise, the operation will terminate immediately upon failing to add a point.

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a PNT, UIS, or CVS Site.Service.  If a UIS or CVS is specified, the service will resolve to its associated PNT.

Points

Yes

A list of points (including a tag and configuration parameters for each) to add to the PNT.

CvsConfirmationTimeoutMilliseconds

No

The amount of time (in milliseconds) to wait for a confirmation from the CVS that the point was created successfully.
Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service.  If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to add points with tags that already exist in the PNT service.

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730" >

<AddPointsReq>

<AllowPartialFailure>true</AllowPartialFailure>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Points>

<Point>

<Tag>

<SvcName>CYGDEMO.SVCMON</SvcName>

<FacilityUDC>

<FacilityId>0_FACILITY</FacilityId>

<UDC>UDC</UDC>

</FacilityUDC>

</Tag>

</Point>

<Point>

<Tag>

<SvcName>CYGDEMO.SVCMON</SvcName>

<FacilityUDC>

<FacilityId>1_FACILITY</FacilityId>

<UDC>UDC</UDC>

</FacilityUDC>

</Tag>

</Point>

<Point>

<Tag>

<SvcName>CYGDEMO.SVCMON</SvcName>

<FacilityUDC>

<FacilityId>2_FACILITY</FacilityId>

<UDC>UDC</UDC>

</FacilityUDC>

</Tag>

<ConfigurationParameters>

<PointActiveStatus>1</PointActiveStatus>

</ConfigurationParameters>

</Point>

<Point>

<Tag>

<SvcName>CYGDEMO.SVCMON</SvcName>

<PointIdLong>

<PointIdLong>LONG_IEXIST</PointIdLong>

</PointIdLong>

</Tag>

</Point>

<Point>

<Tag>

<SvcName>CYGDEMO.SVCMON</SvcName>

<FacilityUDC>

<FacilityId>IEXIST</FacilityId>

<UDC>UDC</UDC>

</FacilityUDC>

</Tag>

</Point>

</Points>

<CvsConfirmationTimeoutMilliseconds>1000</CvsConfirmationTimeoutMilliseconds>

</AddPointsReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with a warning to indicate that a point with the facility ID “IEXIST” and UDC “UDC”, and a point with long point ID “LONG_IEXIST” already exist in the PNT service.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<AddPointsResp>

<PointsAdded>

<Point>

<PointAttributes>

<PointSite>CYGDEMO</PointSite>

<PointService>SVCMON</PointService>

<PointId>00009337</PointId>

<PointIdLong>0_FACILITY_UDC</PointIdLong>

<PointFacilityId>0_FACILITY</PointFacilityId>

<PointUniformDataCode>UDC</PointUniformDataCode>

</PointAttributes>

</Point>

<Point>

<PointAttributes>

<PointSite>CYGDEMO</PointSite>

<PointService>SVCMON</PointService>

<PointId>00009338</PointId>

<PointIdLong>1_FACILITY_UDC</PointIdLong>

<PointFacilityId>1_FACILITY</PointFacilityId>

<PointUniformDataCode>UDC</PointUniformDataCode>

</PointAttributes>

</Point>

<Point>

<PointAttributes>

<PointSite>CYGDEMO</PointSite>

<PointService>SVCMON</PointService>

<PointId>00009339</PointId>

<PointIdLong>2_FACILITY_UDC</PointIdLong>

<PointFacilityId>2_FACILITY</PointFacilityId>

<PointUniformDataCode>UDC</PointUniformDataCode>

</PointAttributes>

</Point>

</PointsAdded>

<OperationResults success="true" resp_timestamp="2011-11-08T03:50:47.689Z" exec_duration="PT1.275S">

<OperationResult type="WARNING" code="50435">Point LONG_IEXIST already exists in CYGDEMO.PNT</OperationResult>

<OperationResult type="WARNING" code="50435">Point CYGDEMO.SVCMON::IEXIST.UDC already exists in CYGDEMO.PNT</OperationResult>

</OperationResults>

</AddPointsResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<AddPointsResp>

<OperationResults success="false" resp_timestamp="2011-07-30T22:12:33.159Z" exec_duration="PT0.003S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS2</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</AddPointsResp>

</CygNetEnterpriseOperations>
Back to top

AddPoint

Given a service name (PNT, UIS or CVS) and a list of point attributes/value pairs, this operation will add a new point record.  The list of point attributes provided must include the minimum set, as specified in the XML schema, to establish a valid point record.  This minimum set is comprised of the site and service, as well as the Long Point ID AND/OR the Facility ID and Uniform Data Code. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<AddPointReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Tag

Yes

The tag of the new point to be added, in the form of long point ID (<PointIdLong>), long point ID and facility/UDC (<PointIdLongFacilityUDC>), or facility/UDC (<FacilityUDC>).

CvsConfirmationTimeoutMilliseconds

No

The amount of time (in milliseconds) to wait for a confirmation from the CVS that the point was created successfully.

ConfigurationParameters

No

A list of point configuration attribute/value pairs to apply to the added point.
Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721" >

<AddPointReq>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Tag>

<SvcName>CYGDEMO.SVCMON</SvcName>

<PointIdLong>

<PointIdLong>0_CYGDEMO_UDC</PointIdLong>

</PointIdLong>

</Tag>

<ConfigurationParameters>

<PointComment>This comment was brought to you by Enterprise Operations</PointComment>

</ConfigurationParameters>

</AddPointReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<AddPointResp>

<PointAttributes>

<PointSite>CYGDEMO</PointSite>

<PointService>SVCMON</PointService>

<PointId>00006817</PointId>

<PointIdLong>0_CYGDEMO_UDC</PointIdLong>

<PointFacilityId></PointFacilityId>

<PointUniformDataCode></PointUniformDataCode>

</PointAttributes>

<OperationResults success="true" resp_timestamp="2011-10-14T23:49:43.452Z" exec_duration="PT0.006S" />

</AddPointResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<AddPointResp>

<OperationResults success="false" resp_timestamp="2011-07-30T22:12:33.159Z" exec_duration="PT0.003S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS2</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</AddPointResp>

</CygNetEnterpriseOperations>
Back to top

UpdatePoints

Given a service name (PNT, UIS or CVS) and a list containing point tags and service names paired with mutable attributes to be updated, this operation will update the attributes of existing point records.  Point attributes available include the “real-time” attributes “current value”, “current timestamp” and the “unreliable point state” (and no other “real-time” attributes or status bits). The list of point attributes provided must not include any of the “key” attributes. If “current timestamp” is not provided, but other “real-time” attributes are, then the current time of the EIS system will be used. Optionally, if AllowPartialFailure is set to true, the operation will continue even when a requested point is unavailable. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<UpdatePointsReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to update a point.  Otherwise, the operation will terminate immediately upon failing to update a point.

UpdatePointList

Yes

A list of points and corresponding update parameters.  For each point (<Point>) in this list, a service name (<SvcName>), tag (<Tag>), and mutable parameters (<EnableScaling>, <ConfigurationParameters>, and <RealtimeParameters>) can be specified.
Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service.  If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to update a point with a tag that does not exist in the PNT service.

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730" >

<UpdatePointsReq>

<AllowPartialFailure>true</AllowPartialFailure>

<UpdatePointList>

<Point>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Tag>CYGDEMO.SVCMON.00000430</Tag>

<ConfigurationParameters>

<PointComment>This comment was modified by Enterprise Operations (UpdatePoints).</PointComment>

</ConfigurationParameters>

<RealtimeParameters>

<PointValue>50</PointValue>

</RealtimeParameters>

</Point>

<Point>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Tag>CYGDEMO.SVCMON.00000431</Tag>

<ConfigurationParameters>

<PointComment>This comment was ALSO modified by Enterprise Operations (UpdatePoints).</PointComment>

</ConfigurationParameters>

</Point>

<Point>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Tag>CYGDEMO.SVCMON.NOTEXIST</Tag>

<ConfigurationParameters>

<PointComment>This comment was ALSO modified by Enterprise Operations (UpdatePoints).</PointComment>

</ConfigurationParameters>

</Point>

</UpdatePointList>

</UpdatePointsReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with a warning to indicate that a point with tag “CYGDEMO.SVCMON.NOTEXIST” does not exist in the PNT service.

<?xml version="1.0" encoding="utf-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<UpdatePointsResp>

<OperationResults success="true" resp_timestamp="2011-05-21T19:31:37.470Z" exec_duration="PT0.430S">

<OperationResult type="WARNING" code="50423">Point CYGDEMO.SVCMON.NOTEXIST does not exist in the PNT</OperationResult>

</OperationResults>

</UpdatePointsResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<UpdatePointsResp>

<OperationResults success="false" resp_timestamp="2011-07-30T22:12:52.437Z" exec_duration="PT0.002S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS1</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</UpdatePointsResp>

</CygNetEnterpriseOperations>
Back to top

UpdatePoint

Given a service name (PNT, UIS or CVS), a point tag, and a list of point attributes/value pairs, this operation will update the attributes of an existing point record.  Point attributes available include configuration attributes and the “real-time” attributes “current value”, “current timestamp” and the “unreliable point state” (and no other “real-time” attributes or status bits). The list of point attributes provided must not include any of the “key” attributes. If “current timestamp” is not provided, but other “real-time” attributes are, then the current time of the EIS system will be used. The return XML will indicate success or failure.

Usage

The following table lists and describes all of the child elements of the request node (<UpdatePointReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Tag

Yes

The tag of the new point to be added, in the form of long point ID (<PointIdLong>), long point ID and facility/UDC (<PointIdLongFacilityUDC>), or facility/UDC (<FacilityUDC>).

EnableScaling

No

Sets whether or not scaling will be enabled for the updated point.

ConfigurationParameters

No

A list of point configuration attribute/value pairs to update.

RealtimeParameters

No

A list of mutable point real-time attribute/value pairs to update.
Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721" >

<UpdatePointReq>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Tag>CYGDEMO.SVCMON.00000430:CYGDEMO_PNT_SVMMSGIN:CYGDEMO_PNT.SVMMSGIN</Tag>

<ConfigurationParameters>

<PointComment>This comment was brought to you by Enterprise Operations</PointComment>

</ConfigurationParameters>

<RealtimeParameters>

<PointValue>50</PointValue>

</RealtimeParameters>

</UpdatePointReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<UpdatePointResp>

<OperationResults success="true" resp_timestamp="2011-09-11T20:44:07.724Z" exec_duration="PT54.956S"></OperationResults>

</UpdatePointResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<UpdatePointResp>

<OperationResults success="false" resp_timestamp="2011-07-30T22:12:33.159Z" exec_duration="PT0.003S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS1</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</UpdatePointResp>

</CygNetEnterpriseOperations>
Back to top

DeletePoints

Given a service name (PNT, UIS or CVS) and a list of point tags, this operation will delete the specified point records.  An option to delete the history point and values of the specified points is also provided.  The return XML will indicate success or failure.

Note: Delete associated point references in the DDS before deleting point records.

Usage

The following table lists and describes all of the child elements of the request node (<DeletePointsReq>).

Element Name Required Description

AllowPartialFailure

No

If this element is set to true, the operation will log an error and continue to run if it fails to delete a point.  Otherwise, the operation will terminate immediately upon failing to delete a point.

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a PNT, UIS, or CVS Site.Service.  If a UIS or CVS is specified, the service will resolve to its associated PNT.

Points

Yes

A list of points (specified by tag, <Tag>) to delete from the PNT.
Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service.  If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

The following example utilizes AllowPartialFailure by attempting to delete a point with a tag that does not exist in the PNT service.

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730" >

<DeletePointsReq>

<AllowPartialFailure>true</AllowPartialFailure>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Points>

<Tag>CYGDEMO.SVCMON:0_FACILITY_UDC</Tag>

<Tag>CYGDEMO.SVCMON:1_FACILITY_UDC</Tag>

<Tag>CYGDEMO.SVCMON:2_FACILITY_UDC</Tag>

<Tag>CYGDEMO.SVCMON:NOTEXIST</Tag>

</Points>

</DeletePointsReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response, with a warning to indicate that a point with tag “CYGDEMO.SVCMON.NOTEXIST” does not exist in the PNT service.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<DeletePointsResp>

<OperationResults success="true" resp_timestamp="2011-05-21T19:06:28.154Z" exec_duration="PT19.608S">

<OperationResult type="WARNING" code="50421">Failed to resolve tag for point 'CYGDEMO.SVCMON:NOTEXIST'</OperationResult>

</OperationResults>

</DeletePointsResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<DeletePointsResp>

<OperationResults success="false" resp_timestamp="2011-07-30T22:13:31.405Z" exec_duration="PT0.002S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS3</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</DeletePointsResp>

</CygNetEnterpriseOperations>
Back to top

DeletePoint

Given a service name (PNT, UIS or CVS) and a point tag, this operation will delete the specified point record. The return XML will indicate success or failure.

Note: Delete associated point references in the DDS before deleting the point record.

Usage

The following table lists and describes all of the child elements of the request node (<DeletePointReq>).

Element Name Required Description

SvcName

Yes

The Site.Service to which to connect.  This parameter must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Tag

Yes

The tag of the point to be deleted.
Target Services

The service name node (<SvcName>) must specify the name of a PNT, UIS, or CVS Site.Service. If a UIS or CVS is specified, the service will resolve to its associated PNT.

Examples

Request

<?xml version="1.0"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721" >

<DeletePointReq>

<SvcName>CYGDEMO.SVCMON</SvcName>

<Tag>CYGDEMO.SVCMON.99999999</Tag>

</DeletePointReq>

</CygNetEnterpriseOperations>
Response

The following example represents a successful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects721">

<DeletePointResp>

<OperationResults success="true" resp_timestamp="2011-09-09T17:36:25.509Z" exec_duration="PT1.380S"></OperationResults>

</DeletePointResp>

</CygNetEnterpriseOperations>

The following example represents an unsuccessful response.

<?xml version="1.0" encoding="UTF-8"?>

<CygNetEnterpriseOperations

xmlns="https://CygNetSCADA.com/Schemas/CygNetEnterpriseObjects730">

<DeletePointResp>

<OperationResults success="false" resp_timestamp="2011-07-30T22:12:33.159Z" exec_duration="PT0.003S">

<OperationResult type="ERROR" code="50003">Security check failed for ACS application ENTOPS and event ACCESS4</OperationResult>

<OperationResult type="ERROR" code="50208">You are not permitted to execute this operation</OperationResult>

</OperationResults>

</DeletePointResp>

</CygNetEnterpriseOperations>
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.